Print
Eliminate the risk of broken links in Sitecore solutions and websites.
1. About External Link Checker Module
A broken link is a hyperlink on a Web page or ftp site which does not work or to which anonymous access is denied.
External broken references can occur in the following field-types:
- Link
- Html
- Rich text
The Link field contains only one link, while a Html or Rich Text field may contain any number of them.
It is possible to implement a custom link handler to process other field-types. ExternalLinkChecker checks links that work from the following protocols: http, https, ftp, telnet, news, and gopher.
2. User Manual
When you start the Reference checker the first time, the following screen appears:
You should begin by updating the list of broken references. To do this click Update reference table in the Tasks list.
As soon as the check is done, you will see the following report:
This is the list of broken references in the database. You can perform actions on the items by using the following buttons:
|
|
Repairs the broken reference. When you click this icon, you will be taken to the actual item to edit the field containing the broken link. Remember to click Save when you finish editing. |
|
|
Cleans the field containing the broken reference. This can only be used with the Link field type. |
|
|
Retests the item that contains the field with the broken link. |
When you are done, you should update the list to make sure that everything is repaired.
When you are completely done, click Close in the Tasks menu.
Checking always works on the selected database not only on the master.
The configuration item contains the following fields:
|
DataProviderClass |
The class name which represents the database of the module |
|
ReferenceExternalTimeout |
Time for checking each external reference |
|
ReferenceLongExternalTimeout |
Extra time used when we have a timeout exception whilst checking |
To implement your custom link handler, follow the steps below:
- Implement a class derived from Sitecore.Modules.ExternalLinkChecker.ItemHandler defined in Sitecore.ExternalLinkChecker.dll
- Add a sub item to the External Link Checker configuration item from the External Link Checker Handler template.
